Vapi Metadata Metamodel FieldInfo

Vapi Metadata Metamodel FieldInfo
Vapi Metadata Metamodel FieldInfo

The Vapi Metadata Metamodel FieldInfo schema contains metamodel information of a field element contained in a structure element.

JSON Example
{
    "name": "string",
    "type": {
        "category": "string",
        "builtin_type": "string",
        "user_defined_type": {
            "resource_type": "string",
            "resource_id": "string"
        },
        "generic_instantiation": "Vapi Metadata Metamodel GenericInstantiation Object"
    },
    "metadata": {
        "metadata": {
            "elements": {
                "elements": {
                    "type": "string",
                    "long_value": 0,
                    "string_value": "string",
                    "list_value": [
                        "string"
                    ],
                    "structure_id": "string",
                    "structure_ids": [
                        "string"
                    ]
                }
            }
        }
    },
    "documentation": "string"
}
string
name
Required

Name of the field element in a canonical format. The format is lower case with underscores. Each underscore represents a word boundary. If there are acronyms in the word, the capitalization is preserved. This format makes it easy to translate the segment into a different naming convention.

type
Required

Type information.

object
metadata
Required

Generic metadata elements for the field element. The key in the map is the name of the metadata element and the value is the data associated with that metadata element.

The Vapi Metadata Metamodel MetadataIdentifier contains possible string values for keys in the map.

string
documentation
Required

English language documentation for the field element. It can contain HTML markup and Javadoc tags.

Property Of